<?php

/**
 *定义可以复用的响应模板：
 *
 * @OA\Schema(
 *       schema="QueryResponse",
 *       description="查询响应模板,带分页",
 *       required={"success","errorCode","errorMessage","showType"},
 *       @OA\Property(
 *            property="errorCode",
 *            type="number",
 *            description="响应码"
 *       ),
 *       @OA\Property(
 *            property="errorMessage",
 *            type="string",
 *            description="响应信息"
 *            ),
 *      @OA\Property(
 *            property="showType",
 *            type="number",
 *            description="ErrorShowType"
 *            ),
 *       @OA\Property(
 *            property="success",
 *            type="boolean",
 *            description="是否成功",
 *       ),
 *     @OA\Property(
 *            property="current",
 *            type="number",
 *            description="current",
 *            nullable="true"
 *       ),
 *     @OA\Property(
 *            property="pageSize",
 *            type="number",
 *            description="pageSize",
 *            nullable="true"
 *       ),
 *     @OA\Property(
 *            property="total",
 *            type="number",
 *            description="total",
 *            nullable="true"
 *       ),
 *     @OA\Property(
 *            property="data",
 *            type="array",
 *            description="查询数据",
 *            @OA\Items(type="AnyValue")
 *     ),
 * )
 *
 * @OA\Schema(
 *       schema="HandleResponse",
 *       description="处理响应模板",
 *       required={"success","errorCode","errorMessage","showType"},
 *       @OA\Property(
 *            property="errorCode",
 *            type="number",
 *            description="响应码"
 *       ),
 *       @OA\Property(
 *            property="errorMessage",
 *            type="string",
 *            description="响应信息"
 *            ),
 *      @OA\Property(
 *            property="showType",
 *            type="number",
 *            description="ErrorShowType"
 *            ),
 *       @OA\Property(
 *            property="success",
 *            type="boolean",
 *            description="是否成功",
 *       ),
 *       @OA\Property(
 *            property="data",
 *            type="AnyValue",
 *            nullable=true,
 *            description="data",
 *       ),
 * )
 *
 * 查询参数,包括分页
 * @OA\Parameter(
 *    name="pageSize",
 *    description="页容量",
 *    in="query",
 *    @OA\Schema(
 *       type="number"
 *    )
 * )
 * @OA\Parameter(
 *    name="current",
 *    description="当前页",
 *    in="query",
 *    @OA\Schema(
 *       type="number"
 *    )
 * )
 * @OA\Parameter(
 *    name="keyword",
 *    description="查询条件",
 *    in="query",
 *    @OA\Schema(
 *       type="AnyValue"
 *    )
 * )
 * @OA\Parameter(
 *    name="name",
 *    description="名称",
 *    in="query",
 *    @OA\Schema(
 *       type="string"
 *    )
 * )
 *
 * @OA\Schema(
 *       schema="GetPageParams",
 *       description="查询参数,包括分页",
 *       @OA\Property(
 *            property="pageSize",
 *            type="number",
 *            description="页容量"
 *       ),
 *       @OA\Property(
 *            property="current",
 *            type="string",
 *            description="响应信息"
 *       ),
 *      @OA\Property(
 *            property="keyword",
 *            type="string",
 *            description="查询关键词"
 *       )
 * )
 *
 *路径参数,一般用于更新或删除
 * @OA\Parameter(
 *    name="id",
 *    description="Field id",
 *    in="path",
 *    required=true,
 *    @OA\Schema(
 *       type="number",
 *       minimum=1
 *    )
 * )
 *
 * @OA\SecurityScheme(
 *     type="http",
 *     description="全局添加API Token鉴权",
 *     scheme="bearer",
 *     bearerFormat="JWT",
 *     in="header",
 *     securityScheme="Authorization-Bearer"
 * )
 *
 * OA\Get(path="/openapi",
 *   tags={"swagger"},
 *   summary="获取openapi.json字符串",
 *   operationId="getOpenapi",
 *   @OA\Response(response="200", description="Success",
 *       @OA\JsonContent(@OA\Property(
 *            property="errorCode",
 *            type="number",
 *            description="响应码"
 *       ))
 *   )
 * )
 *
 */